flush-write-stream

What is flush-write-stream?

The flush-write-stream npm package is a Node.js module that provides a writable stream with a flush function that is called before the 'finish' event is emitted. This allows for any remaining data to be processed or cleanup tasks to be performed before the stream is closed.

What are flush-write-stream's main functionalities?

Creating a writable stream with a flush function

This feature allows you to create a writable stream that will execute a custom flush function before the stream finishes. The flush function is useful for handling any remaining data or performing cleanup tasks.

const FlushWriteStream = require('flush-write-stream');
const writable = FlushWriteStream((data, enc, cb) => {
  // Write data logic
  cb();
}, (cb) => {
  // Flush logic
  cb();
});

Other packages similar to flush-write-stream

through2

Through2 is a tiny wrapper around Node streams.Transform that makes it easier to create transform streams. It is similar to flush-write-stream in that it allows you to process data as it passes through the stream, but it does not provide a specific flush functionality.

pumpify

Pumpify combines an array of streams into a single duplex stream. It can be used to pipe between streams and handle their errors properly. While it is related to stream processing like flush-write-stream, it focuses on combining streams rather than providing a flush mechanism.

end-of-stream

End-of-stream is a module that helps you call a callback when a readable/writable/duplex stream has completed or failed. Unlike flush-write-stream, it does not provide a way to define a flush function, but it is useful for handling the end of a stream.

README

flush-write-stream

A write stream constructor that supports a flush function that is called before finish is emitted

npm install flush-write-stream

Usage

var writer = require('flush-write-stream')

var ws = writer(write, flush)

ws.on('finish', function () {
  console.log('finished')
})

ws.write('hello')
ws.write('world')
ws.end()

function write (data, enc, cb) {
  // i am your normal ._write method
  console.log('writing', data.toString())
  cb()
}

function flush (cb) {
  // i am called before finish is emitted
  setTimeout(cb, 1000) // wait 1 sec
}

If you run the above it will produce the following output

writing hello
writing world
(nothing happens for 1 sec)
finished

API

var ws = writer([options], write, [flush])

Create a new writable stream. Options are forwarded to the stream constructor.

var ws = writer.obj([options], write, [flush])

Same as the above except objectMode is set to true per default.

License

MIT